Enable full `toml` configuration and `pyproject.toml` #534

RuRo · 2021-05-01T02:35:56Z

This PR closes #447.

Changes

Fix a small unrelated bug, where inline comments in .ini files behaved differently when autodetected by _get_config_file_in_folder and when manually specified by --config.
Add toml as a package dependency (setup.py) and as a pinned runtime dependency (requirements/runtime.txt).
Implement TomlParser - a thin wrapper around the toml library with minimal API parity with RawConfigParser.
Autodetect pyproject.toml configuration
Autodetect tool.pydocstyle section

Implement error code list support for toml. This is so that you can use

select = [
    "D100",
    # This line is ignored
    "D103",
]

and not only

select = "D100,D103"

Almost all tests in test_integration.py which used the env fixture now are run for both toml and ini versions of the configuration (47 tests).
2 tests are only run for ini configuration: test_ignores_whitespace_in_fixed_option_set and test_multiple_lined_config_file. In toml, strings must be quoted, so comments and newlines inside the strings don't make much sense, which is what these tests are checking. Instead, I've implemented 2 "equivalent" toml tests that also check the list support: test_accepts_ignore_error_code_list and test_accepts_select_error_code_list.

Please make sure to check for the following items:

Add unit tests and integration tests where applicable.
Add a line to the release notes (docs/release_notes.rst) under "Current Development Version".
Make sure to include the PR number after you open and get one.

There's currently no "Current Development Version" section in docs/release_notes.rst. Where should I add the changes?

src/pydocstyle/config.py

src/tests/test_integration.py

src/pydocstyle/config.py

RuRo · 2021-05-07T10:20:26Z

@Nurdok, sorry to bother you, but can you maybe take a look at this PR?

Nurdok · 2021-05-08T13:35:23Z

@samj1912 is the current active maintainer - I'll let him address this PR.

sambhav · 2021-05-08T13:44:04Z

Will take a look this weekend :)

sambhav · 2021-05-09T10:54:52Z

This generally looks good to me, just a couple of comments -

Can we make toml an optional dependency so that if it's not present, people can still use pydocstyle. This is so that you can install pydocstyle with toml support using something like pip install pydocstyle[toml] or if you don't want to have support for it, you can just use pip install pydocstyle. Incase toml is not present as a dependency and pyproject.toml is, pydocstyle could show a warning that it maybe missing user configuration due to the lack of toml dependency and that users should install toml to get support for it.
Can we have the section names conditional to the file being parsed? I would prefer if we only parsed the tool.pydocstyle section in pyproject.toml and not the other top level sections.

RuRo · 2021-05-09T11:52:00Z

Theoretically we can, however it's not clear to me, what should happen if the pyproject.toml file is present, but toml is not installed.
- Raising an error might break existing projects that currently have a pyproject.toml file and either don't have a .pydocstyle or have it in a subdirectory instead of in the root of the project.
- Ignoring the pyproject.toml file if toml is not installed can lead to unexpected results, since toml can also be installed as a dependency of some other package or can be installed on the developers machine, but not in CI or vice-versa.
Done. Just to be clear,

I would prefer if we only parsed the tool.pydocstyle section in pyproject.toml and not the other top level sections.

toml will still technically parse the whole pyproject.toml file no matter what. I just changed it so that the pydocstyle configuration keys are only looked up in tool.* instead of also checking for pydocstyle/pep257 in the root.

sambhav · 2021-05-09T13:54:21Z

Theoretically we can, however it's not clear to me, what should happen if the pyproject.toml file is present, but toml is not installed.

Raising an error might break existing projects that currently have a pyproject.toml file and either don't have a .pydocstyle or have it in a subdirectory instead of in the root of the project.

Ignoring the pyproject.toml file if toml is not installed can lead to unexpected results, since toml can also be installed as a dependency of some other package or can be installed on the developers machine, but not in CI or vice-versa.

I meant something similar to this - https://github.com/cruft/cruft/pull/107/files

Done. Just to be clear,

I would prefer if we only parsed the tool.pydocstyle section in pyproject.toml and not the other top level sections.

toml will still technically parse the whole pyproject.toml file no matter what. I just changed it so that the pydocstyle configuration keys are only looked up in tool.* instead of also checking for pydocstyle/pep257 in the root.

Yup, this is what I meant :).

RuRo · 2021-05-09T15:00:49Z

I meant something similar to this - https://github.com/cruft/cruft/pull/107/files

Sure, I guess a warning is an acceptable compromise.

sambhav · 2021-05-09T15:07:14Z

Code wise it all looks good :) Could you also update the changelog with an entry for this PR and if possible update the docs! Thanks

RuRo · 2021-05-09T15:14:11Z

Could you also update the changelog with an entry for this PR

As I mentioned in the original post

There's currently no "Current Development Version" section in docs/release_notes.rst. Where should I add the changes?

sambhav · 2021-05-09T23:31:40Z

Thank you for this PR :)

RuRo · 2021-05-09T23:41:12Z

👍

Btw, I was wondering, does pydocstyle have a release schedule? Do you have any estimations of when might the next version be released? I'm itching to bump the version in my personal projects :^)

sambhav · 2021-05-09T23:42:43Z

It does not have a fixed release schedule. I can cut a release sometime next week though :)

RuRo · 2021-05-10T00:03:08Z

That would be much appreciated.

Nytelife26 · 2021-05-11T13:27:55Z

Nice work :) turns out it wasn't at all as complex as implied, eh. That, or you're a software engineer from beyond modern earth.

All jokes aside, thank you for this - I'll be using this feature in proselint shortly too

RuRo added 10 commits May 1, 2021 04:56

fix missing inline_comment_prefixes

4bc92d7

implement TomlParser

999c5fb

add pyproject.toml support

61a9d40

add tool.pydocstyle section support

7eee199

implement variable config_name for tests

2ee9049

run all env tests for tox.ini and pyproject.toml

ed42666

exclude ini-specific tests for toml

752c8f1

add toml dependency

2c46920

support [] lists in toml config

39466c9

add tests for [] lists in toml configs

56acdbd

Nytelife26 suggested changes May 1, 2021

View reviewed changes

src/pydocstyle/config.py Outdated Show resolved Hide resolved

src/tests/test_integration.py Outdated Show resolved Hide resolved

src/pydocstyle/config.py Outdated Show resolved Hide resolved

src/pydocstyle/config.py Outdated Show resolved Hide resolved

RuRo added 2 commits May 2, 2021 02:43

nitpicks & code quality improvements

b399aae

nitpicks & code quality improvements 2

cecf649

RuRo added 2 commits May 9, 2021 14:32

only consider tool.* sections in toml files

d1631d8

add file extension in test_config_path

06c13b4

make toml an optional dependency

0a94320

RuRo and others added 2 commits May 9, 2021 18:36

document the toml configuration support

572ec90

Update release_notes.rst

6582981

sambhav approved these changes May 9, 2021

View reviewed changes

sambhav merged commit 8d8b319 into PyCQA:master May 9, 2021

rharish101 mentioned this pull request May 18, 2021

Added entry for pydocstyle carlosperate/awesome-pyproject#45

Merged

7 tasks

weibullguy mentioned this pull request Jul 27, 2021

Migrate pydocstyle Configuration to pyproject.toml ReliaQualAssociates/ramstk#626

Closed

1 task

vyasr mentioned this pull request Aug 2, 2022

The pre-commit hook fails silently when a pyproject.toml file exists and toml isn't installed #603

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enable full `toml` configuration and `pyproject.toml` #534

Enable full `toml` configuration and `pyproject.toml` #534

RuRo commented May 1, 2021 •

edited

Loading

RuRo commented May 7, 2021

Nurdok commented May 8, 2021

sambhav commented May 8, 2021

sambhav commented May 9, 2021 •

edited

Loading

RuRo commented May 9, 2021

sambhav commented May 9, 2021

RuRo commented May 9, 2021

sambhav commented May 9, 2021

RuRo commented May 9, 2021

sambhav commented May 9, 2021

RuRo commented May 9, 2021

sambhav commented May 9, 2021

RuRo commented May 10, 2021

Nytelife26 commented May 11, 2021

Enable full toml configuration and pyproject.toml #534

Enable full toml configuration and pyproject.toml #534

Conversation

RuRo commented May 1, 2021 • edited Loading

Changes

Please make sure to check for the following items:

RuRo commented May 7, 2021

Nurdok commented May 8, 2021

sambhav commented May 8, 2021

sambhav commented May 9, 2021 • edited Loading

RuRo commented May 9, 2021

sambhav commented May 9, 2021

RuRo commented May 9, 2021

sambhav commented May 9, 2021

RuRo commented May 9, 2021

sambhav commented May 9, 2021

RuRo commented May 9, 2021

sambhav commented May 9, 2021

RuRo commented May 10, 2021

Nytelife26 commented May 11, 2021

Enable full `toml` configuration and `pyproject.toml` #534

Enable full `toml` configuration and `pyproject.toml` #534

RuRo commented May 1, 2021 •

edited

Loading

sambhav commented May 9, 2021 •

edited

Loading